Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(specs): rename composition to composition-full (private) and add composition (public) #4357

Merged
merged 33 commits into from
Jan 22, 2025
Merged

feat(specs): rename composition to composition-full (private) and add composition (public) #4357

merged 33 commits into from
Jan 22, 2025

Conversation

e-krebs
Copy link
Contributor

@e-krebs e-krebs commented Jan 14, 2025 •
edited by shortcuts
Loading

🧭 What and Why

🎟 JIRA Ticket: EMERCH-1832 https://algolia.atlassian.net/browse/DI-3391

Changes included:

  • rename composition to composition-full (this is the existing private Package)
    • breaking change: the exported function (and its type) changes from createCompositionClient to createCompositionFullClient
  • create new composition specs (this is the public Package)

🧪 Test

@e-krebs e-krebs self-assigned this Jan 14, 2025
@algolia-bot
Copy link
Collaborator

algolia-bot commented Jan 14, 2025 •
edited
Loading

💥 Breaking changes detected !!

Either this PR or a previous PR not released yet introduced breaking changes, be careful when merging.
You can find the details in the 'client java@17' CI job.

✔️ Code generated!

Name Link
🪓 Triggered by 15c5f6d218242341aede5b3dfc884af07d2453a2
🍃 Generated commit 9785b90f48de5ec4f7ae427ce80b827f090f862f
🌲 Generated branch generated/feat/composition-public-package
📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
go 1668
javascript 1614
php 1452
csharp 1233
java 1113
python 1104
ruby 862
swift 750

@shortcuts shortcuts force-pushed the feat/composition-public-package branch from a1dbe5f to 93ef4eb Compare January 14, 2025 12:21
@shortcuts shortcuts changed the title feat(specs): rename composition to composition-full (private) and add composition (public) feat(specs): rename composition to composition-full (private) and add composition (public) [skip-bc] Jan 14, 2025
shortcuts
shortcuts reviewed Jan 14, 2025
View reviewed changes
config/clients.config.json
@@ -163,7 +174,7 @@
"output": "clients/algoliasearch-client-javascript/packages/client-search"
},
{
"name": "composition",
"name": "composition-full",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wdyt of admin instead of full?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

those extra endpoints are clearly not for admin,
they will be public eventually, just not now.
so 😕

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok make sense so at some point the composition client will be used in favor of the full right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's what I expect, yes

@millotp millotp changed the title feat(specs): rename composition to composition-full (private) and add composition (public) [skip-bc] feat(specs): rename composition to composition-full (private) and add composition (public) Jan 16, 2025
@shortcuts
Copy link
Member

kotlin: ambiguity in imports for requestbody, either rename or import the package directly

@millotp millotp marked this pull request as ready for review January 22, 2025 08:17
@millotp millotp requested a review from a team as a code owner January 22, 2025 08:17
@millotp millotp requested review from morganleroi and Fluf22 January 22, 2025 08:17
@millotp millotp merged commit 83f188d into main Jan 22, 2025
28 checks passed
@millotp millotp deleted the feat/composition-public-package branch January 22, 2025 08:17
algolia-bot added a commit that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
9bfd097 
… composition (public) (#4357) (generated) [skip ci]

Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
917f215 
… composition (public) (generated)

algolia/api-clients-automation#4357

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-dart that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
25e0431 
… composition (public) (generated)

algolia/api-clients-automation#4357

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
9d3de40 
… composition (public) (generated)

algolia/api-clients-automation#4357

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
a850bab 
… composition (public) (generated)

algolia/api-clients-automation#4357

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
2ac2f2f 
… composition (public) (generated)

algolia/api-clients-automation#4357

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
4579300 
… composition (public) (generated)

algolia/api-clients-automation#4357

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
3f47805 
… composition (public) (generated)

algolia/api-clients-automation#4357

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-python that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
cc946ce 
… composition (public) (generated)

algolia/api-clients-automation#4357

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-ruby that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
b23c822 
… composition (public) (generated)

algolia/api-clients-automation#4357

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
algolia-bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Jan 22, 2025
@algolia-bot @e-krebs
@shortcuts @millotp
feat(specs): rename composition to composition-full (private) and add…
5f536fb 
… composition (public) (generated)

algolia/api-clients-automation#4357

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Emmanuel Krebs <[email protected]>
Co-authored-by: shortcuts <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shortcuts shortcuts shortcuts left review comments

@millotp millotp millotp approved these changes

@morganleroi morganleroi Awaiting requested review from morganleroi morganleroi is a code owner automatically assigned from algolia/api-clients-automation

@Fluf22 Fluf22 Awaiting requested review from Fluf22 Fluf22 is a code owner automatically assigned from algolia/api-clients-automation

Assignees

@e-krebs e-krebs

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@e-krebs @algolia-bot @shortcuts @millotp